Skip to content

docs: add Use with AI tools section to package READMEs#38827

Open
KarishmaGhiya wants to merge 10 commits into
Azure:mainfrom
KarishmaGhiya:kag-sxs-20260604-142907-copilot-claude-opus-4-7-high
Open

docs: add Use with AI tools section to package READMEs#38827
KarishmaGhiya wants to merge 10 commits into
Azure:mainfrom
KarishmaGhiya:kag-sxs-20260604-142907-copilot-claude-opus-4-7-high

Conversation

@KarishmaGhiya
Copy link
Copy Markdown
Member

Adds a new ## Use with AI tools section above the ## Troubleshooting section in 425 package READMEs under sdk/<service>/<package>/README.md.

The new section reads:

Use with AI tools

AI coding tools such as VS Code and GitHub Copilot can help you write and debug code that uses this library. See Using the Azure SDK for JavaScript with AI tools for available integrations.

Scope

  • Only top-level package READMEs at sdk/<service>/<package>/README.md were modified.
  • 28 non-library READMEs (perf-tests, scaffolders, mock-hub, etc.) that do not have a ## Troubleshooting section were skipped.

Implementation notes

  • Heading level is ## to match the sibling ## Troubleshooting section.
  • Original line endings (LF/CRLF) and UTF-8 (no BOM) encoding preserved per file.
  • Proper blank lines on both sides of the new section.

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

KarishmaGhiya and others added 9 commits March 5, 2026 18:40
Add a new `## Use with AI tools` section above the `## Troubleshooting`  section in 425 package READMEs under sdk/<service>/<package>/README.md.

The section points users to https://aka.ms/azsdk/js/ai for guidance on  using AI coding tools (VS Code, GitHub Copilot) with the Azure SDK for JavaScript.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 4, 2026 21:50
@KarishmaGhiya KarishmaGhiya requested a review from a team as a code owner June 4, 2026 21:50
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

members: {
kind: string;
name: string;
version?: string;
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
version?: string;

configPath: string,
pkgPath: string,
projectInfo: ProjectInfo,
version: string,
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
version: string,

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Untriaged
Status: No status
Status: Untriaged
Status: Untriaged

Development

Successfully merging this pull request may close these issues.

2 participants